Retrieve All Counterparty Accounts

GET /api/v1/Counterparties/accounts

Description

This endpoint is used to retrieve all bank accounts for a counterparty.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain

• application/json

• text/json

Path Parameters:

• version: string, required

Query Parameters:

• counterpartyId: string, required

• pageNumber: integer, optional

• pageSize: integer, optional

URL:

• GET: {{baseUrl API url}}/api/v1/Counterparties/accounts?counterpartyId={counterpartyId}&pageNumber={pageNumber}&pageSize={pageSize}

Response:

• A CounterpartyBankAccountResponseListPagedResponse object containing a list of bank accounts for the specified counterparty.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example:

Request:

GET /api/v1/Counterparties/accounts?counterpartyId=1234567890&pageNumber=1&pageSize=10

Response:

HTTP/1.1 200 OK
{
  "totalCount": 1,
  "items": [
    {
      "id": "0987654321",
      "accountNumber": "1234567890",
      "accountType": "Checking",
      "bankName": "Bank B",
      "branchCode": "54321",
      "countryCode": "US",
      "currencyCode": "USD",
      "accountHolderName": "Jane Doe"
    }
  ]
}

Method: GET

/api/v1/Counterparties/accounts?counterpartyId=<uuid>&pageNumber=<integer>&pageSize=<integer>

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
counterpartyId	<uuid>
pageNumber	<integer>
pageSize	<integer>

Response: 200

{
  "pageNumber": "<integer>",
  "pageSize": "<integer>",
  "total": "<integer>",
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": [
    {
      "id": "<uuid>",
      "merchantId": "<uuid>",
      "counterpartyId": "<uuid>",
      "account": 2,
      "counterpartyType": 1,
      "accountType": 2,
      "bankCode": "<string>",
      "bankName": "<string>",
      "accountNumber": "<string>",
      "accountName": "<string>",
      "iban": "<string>",
      "swiftCode": "<string>",
      "bankAddress": "<string>",
      "routingNumber": "<string>"
    },
    {
      "id": "<uuid>",
      "merchantId": "<uuid>",
      "counterpartyId": "<uuid>",
      "account": 3,
      "counterpartyType": 1,
      "accountType": 3,
      "bankCode": "<string>",
      "bankName": "<string>",
      "accountNumber": "<string>",
      "accountName": "<string>",
      "iban": "<string>",
      "swiftCode": "<string>",
      "bankAddress": "<string>",
      "routingNumber": "<string>"
    }
  ]
}